home *** CD-ROM | disk | FTP | other *** search
/ Delphi Informant Complete 1995 - 2000 / Delphi Informant Complete 1995 to 2000.iso / Delphi Informant Magazine Complete Works SOURCE CODE 1998.rar / 1998 / May / di9805rl / HtmlHelp.pas < prev   
Pascal/Delphi Source File  |  1997-10-21  |  13KB  |  356 lines
  1. (******************************************************************************
  2. *                                  HtmlHelp                                   *
  3. * HtmlHelp constants, translated from htmlhelp.h                              *
  4. * Translated by: Ron Loewy, HyperAct, Inc.                                    *
  5. * Last Update: Oct. 21, 1997                                                  *
  6. ******************************************************************************)
  7. unit HtmlHelp;
  8.  
  9. interface
  10.  
  11. uses
  12.     windows
  13.     ,Graphics
  14.     ;
  15.  
  16. (* Commands to pass to HtmlHelp *)
  17. const
  18.    HH_DISPLAY_TOPIC           = $0000;
  19.    HH_DISPLAY_TOC               = $0001;    // not currently implemented
  20.    HH_DISPLAY_INDEX           = $0002;    // not currently implemented
  21.    HH_DISPLAY_SEARCH           = $0003;    // not currently implemented
  22.    HH_SET_WIN_TYPE            = $0004;
  23.    HH_GET_WIN_TYPE            = $0005;
  24.    HH_GET_WIN_HANDLE           = $0006;
  25.    HH_GET_INFO_TYPES           = $0007;    // not currently implemented
  26.    HH_SET_INFO_TYPES           = $0008;    // not currently implemented
  27.    HH_SYNC                       = $0009;
  28.    HH_ADD_NAV_UI               = $000A;    // not currently implemented
  29.    HH_ADD_BUTTON               = $000B;    // not currently implemented
  30.    HH_GETBROWSER_APP           = $000C;    // not currently implemented
  31.    HH_KEYWORD_LOOKUP           = $000D;
  32.    HH_DISPLAY_TEXT_POPUP    = $000E;    // display string resource id or text in a popup window
  33.    HH_HELP_CONTEXT            = $000F;    // display mapped numeric value in dwData
  34.  
  35. (* window properties *)
  36. const
  37.    HHWIN_PROP_ONTOP              = 2;      // Top-most window (not currently implemented)
  38.    HHWIN_PROP_NOTITLEBAR       = 4;      // no title bar
  39.    HHWIN_PROP_NODEF_STYLES    = 8;      // no default window styles (only HH_WINTYPE.dwStyles)
  40.    HHWIN_PROP_NODEF_EXSTYLES  = 16;      // no default extended window styles (only HH_WINTYPE.dwExStyles)
  41.    HHWIN_PROP_TRI_PANE           = 32;      // use a tri-pane window
  42.    HHWIN_PROP_NOTB_TEXT          = 64;   // no text on toolbar buttons
  43.    HHWIN_PROP_POST_QUIT          = 128;  // post WM_QUIT message when window closes
  44.    HHWIN_PROP_AUTO_SYNC          = 256;  // automatically ssync contents and index
  45.    HHWIN_PROP_TRACKING           = 512; // send tracking notification messages
  46.    HHWIN_PROP_TAB_SEARCH       = 1024; // include search tab in navigation pane
  47.    HHWIN_PROP_TAB_HISTORY       = 2048;   // include history tab in navigation pane
  48.    HHWIN_PROP_TAB_FAVORITES   = 4096;   // include favorites tab in navigation pane
  49.    HHWIN_PROP_CHANGE_TITLE    = 8192;   // Put current HTML title in title bar
  50.    HHWIN_PROP_NAV_ONLY_WIN    = 16384;   // Only display the navigation window
  51.    HHWIN_PROP_NO_TOOLBAR       = 32768;   // Don't display a toolbar
  52.  
  53. (* window parameters *)
  54. const
  55.   HHWIN_PARAM_PROPERTIES     =    2;     // valid fsWinProperties
  56.   HHWIN_PARAM_STYLES             = 4;     // valid dwStyles
  57.   HHWIN_PARAM_EXSTYLES         = 8;     // valid dwExStyles
  58.   HHWIN_PARAM_RECT             = 16;     // valid rcWindowPos
  59.   HHWIN_PARAM_NAV_WIDTH         = 32;     // valid iNavWidth
  60.   HHWIN_PARAM_SHOWSTATE         = 64;     // valid nShowState
  61.   HHWIN_PARAM_INFOTYPES         = 128;     // valid ainfoTypes
  62.   HHWIN_PARAM_TB_FLAGS         = 256;     // valid fsToolBarFlags
  63.   HHWIN_PARAM_EXPANSION         = 512;     // valid fNotExpanded
  64.   HHWIN_PARAM_TABPOS             = 1024;     // valid tabpos
  65.   HHWIN_PARAM_TABORDER         = 2048;     // valid taborder
  66.   HHWIN_PARAM_HISTORY_COUNT =    4096;     // valid cHistory
  67.   HHWIN_PARAM_CUR_TAB          = 8192;     // valid curNavType
  68.  
  69. (* button constants *)
  70. const
  71.    HHWIN_BUTTON_EXPAND        = 2;     // Expand/contract button
  72.    HHWIN_BUTTON_BACK           = 4;     // Back button
  73.    HHWIN_BUTTON_FORWARD       = 8;     // Forward button
  74.    HHWIN_BUTTON_STOP           = 16;     // Stop button
  75.    HHWIN_BUTTON_REFRESH        = 32;     // Refresh button
  76.    HHWIN_BUTTON_HOME            = 64;     // Home button
  77.    HHWIN_BUTTON_BROWSE_FWD = 128;     // not implemented
  78.    HHWIN_BUTTON_BROWSE_BCK = 256;     // not implemented
  79.    HHWIN_BUTTON_NOTES        = 512;     // not implemented
  80.    HHWIN_BUTTON_CONTENTS    = 1024;     // not implemented
  81.    HHWIN_BUTTON_SYNC            = 2048;     // Sync button
  82.    HHWIN_BUTTON_OPTIONS        = 4096;     // Options button
  83.    HHWIN_BUTTON_PRINT        = 8192;     // Print button
  84.    HHWIN_BUTTON_INDEX        = 16384;     // not implemented
  85.    HHWIN_BUTTON_SEARCH         = 32768;     // not implemented
  86.    HHWIN_BUTTON_HISTORY        = 65536;     // not implemented
  87.    HHWIN_BUTTON_FAVORITES    = 131072;     // not implemented
  88.    HHWIN_BUTTON_JUMP1        = 262144; // Jump 1 button
  89.    HHWIN_BUTTON_JUMP2        = 524288; // Jump 2 button
  90.    HHWIN_BUTTON_ZOOM            = HHWIN_Button_Jump2 * 2;
  91.    HHWIN_BUTTON_TOC_NEXT    = HHWIN_Button_Zoom * 2;
  92.    HHWIN_BUTTON_TOC_PREV    = HHWIN_Button_Toc_Next * 2;
  93.  
  94. const
  95.    HHWIN_DEF_Buttons = HHWIN_Button_Expand or
  96.                        HHWIN_Button_Back or
  97.                        HHWIN_Button_Options or
  98.                        HHWIN_Button_Print;
  99.  
  100. (* Button ID's *)
  101. const
  102.    IDTB_EXPAND             = 200;
  103.    IDTB_CONTRACT            = 201;
  104.    IDTB_STOP                = 202;
  105.    IDTB_REFRESH            = 203;
  106.    IDTB_BACK                = 204;
  107.    IDTB_HOME                = 205;
  108.    IDTB_SYNC                = 206;
  109.    IDTB_PRINT                = 207;
  110.    IDTB_OPTIONS            = 208;
  111.    IDTB_FORWARD            = 209;
  112.    IDTB_NOTES                = 210; // not implemented;
  113.    IDTB_BROWSE_FWD         = 211;
  114.    IDTB_BROWSE_BACK        = 212;
  115.    IDTB_CONTENTS            = 213; // not implemented;
  116.    IDTB_INDEX                = 214; // not implemented;
  117.    IDTB_SEARCH             = 215; // not implemented;
  118.    IDTB_HISTORY            = 216; // not implemented;
  119.    IDTB_FAVORITES            = 217; // not implemented;
  120.    IDTB_JUMP1                = 218;
  121.    IDTB_JUMP2                = 219;
  122.    IDTB_CUSTOMIZE            = 221;
  123.    IDTB_ZOOM                = 222;
  124.    IDTB_TOC_NEXT            = 223;
  125.    IDTB_TOC_PREV            = 224;
  126.  
  127. (* Notification Codes *)
  128. const
  129.    HHN_First = cardinal(-860);
  130.    HHN_Last =  cardinal(-879);
  131.  
  132.    HHN_NavComplete = HHN_First - 0;
  133.    HHN_Track = HHN_First - 1;
  134.  
  135. type
  136.    HHN_Notify = record
  137.       hdr : pointer; // NMHDR ?
  138.       pszUrl : PWideChar; // PWideChar
  139.    end;
  140.  
  141.    HH_Popup = record
  142.       cbStruct : integer; // sizeof this structure
  143.       hinst : THandle; // instance handle for string resource
  144.       idString : cardinal; // string resource id, or text id if pszfile is specified in HH Call
  145.       pszText : PChar; // used if idstring is 0
  146.       pt : TPoint; // top center of popup window
  147.       clrForeground : TColor; // ? ColorRef, -1 for default
  148.       clrBackground : TColor; // ? ColorRef, -1 for default
  149.       rcMargins : TRect; // amount of space between edges of window and text, -1 for each member to ignore
  150.       pszFont : PChar; // facename, pointsize, charset, BOLD ITALIC UNDERLINE
  151.    end; // HH_Popup
  152.  
  153.    HH_AKLINK = record
  154.       cbStruct : integer; // struct size
  155.       fReserved : bool; // set to false
  156.       pszKeywords : PChar; // ; separated keywords
  157.       pszUrl : PChar; // url to jump if no keywords found
  158.       pszMsgText : PChar; // message if no kwd and url is NULL
  159.       pszMsgTitle : PChar; // title ....
  160.       pszWindow : PChar; // window to display url in
  161.       fIndexOnFail : bool; // display index if kwd lookup fails
  162.    end; // HH_AKLINK
  163.  
  164. type
  165.    HHWin_NavTypes = (HHWIN_NAVTYPE_TOC,
  166.                      HHWIN_NAVTYPE_INDEX,
  167.                      HHWIN_NAVTYPE_SEARCH,
  168.                      HHWIN_NAVTYPE_HISTORY,
  169.                      HHWIN_NAVTYPE_FAVOURITES);
  170.  
  171. type
  172.    HH_InfoType = longint;
  173.    PHH_InfoType = ^ HH_InfoType;
  174.  
  175. type
  176.    HHWin_NavTabs = (HHWIN_NavTab_Top,
  177.                     HHWIN_NavTab_Left,
  178.                     HHWIN_NavTab_Bottom);
  179.  
  180. const
  181.    HH_Max_Tabs = 19; // max # of tabs
  182.  
  183. type
  184.    HH_Tabs = (
  185.     HH_TAB_CONTENTS,
  186.     HH_TAB_INDEX,
  187.     HH_TAB_SEARCH,
  188.     HH_TAB_HISTORY,
  189.     HH_TAB_FAVORITES
  190.    );
  191.  
  192. // HH_DISPLAY_SEARCH Command Related Structures and Constants
  193.  
  194. const
  195.    HH_FTS_DEFAULT_PROXIMITY = (-1);
  196.  
  197. type
  198.    HH_FTS_Query = record
  199.       cbStruct : integer; // sizeof structure
  200.       fUniCodeStrings : bool; // true if all strings are unicode
  201.       pszSearchQuery : PChar; // string with the search query
  202.       iProximity : longint; // word proximity
  203.       fStemmedSearch : bool; // true for stemmed search only
  204.       fTitleOnly : bool; // true for title search only
  205.       fExecute : bool; // true to initiate the search
  206.       pszWindow : PChar; // window to display in
  207.    end; // HH_FTS_Query